# -*- coding: latin-1 -*-
# Copyright (c) 2007-2009 Jorge Ortiz Romo <jortizromo@gmail.com>
#                         Freymam Vallejo Cuero <freturn@gmail.com>
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation
# files (the "Software"), to deal in the Software without
# restriction, including without limitation the rights to use,
# copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following
# conditions:

# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.

# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
# OTHER DEALINGS IN THE SOFTWARE.
# Import the module and instantiate a pygraph object

'''
Created on Dec 7, 2009

@author: Freymam Vallejo
@author: Jorge Ortiz
'''

from __future__ import division
import Degree

def digraph_degree_node_type(digraph, node):
    """
    Classification of the nodes according to the amount of incoming or outgoing links. Very useful for the description of roles or positions.

    @type graph: Digraph.
    @param graph: digraph.

    @type graph: Node.
    @param graph: node.

    @rtype: str.
    @return: Text that indicate one of the following four classes: Isolate, Transmitter, Receiver, Carrier o Ordinary.
    """

    #Get the node InDegree
    indegree = Degree.digraph_indegree(digraph, node)
    #Get the node OutDegree
    outdegree = Degree.digraph_outdegree(digraph, node)
    
    #Assignment to the output variable of type value.
    #As:
    #            Isolate     Transmitter     Receiver    Ordinary    Carrier
    #indegree  : 0           0               > 0         > 0         == 1
    #outdegree : 0           > 0             0           > 0         == 1
    if indegree == 0:
        if outdegree == 0:
            type_degree = 'Isolate'
        else: type_degree = 'Transmitter'
    else:
        if indegree > 0:
            if outdegree == 0:
                type_degree = 'Receiver'
            else: type_degree = 'Ordinary'
    if indegree == outdegree == 1:
        type_degree = 'Carrier'

    return type_degree
